v0.16.0

Compare Source

💥 Breaking Changes

This release is not backwards compatible. The following breaking changes have been made.

As a program

• Python 3.9 is now end-of-life, and no longer supported
• Different calling conventions. See --help for a full list of options
  • proselint --version is now proselint version, for consistency with other linters
  • proselint is now proselint check
  • proselint --dump-config and --dump-default-config are now proselint dump-config and dump-config --default
  • --time and --clean have been removed
  • --debug is now --verbose
  • --json and --compact are now --output-format json and --output-format compact
• Several checks have been removed and renamed as an implementation of #​1373.
  User configurations will need to be modified accordingly
  • airlinese, bureaucratese, chatspeak, commercialese, corporate_speak, and jargon have been recategorized under industrial_language.
  • security, links, and cursing (except for cursing.nword) have been removed
  • sexism, lgbtq, and cursing.nwordhave been recategorized under social_awareness
  • consistency.spacing has been moved to typography.punctuation.spacing
  • typography.exclamation and hyperbole have been merged and moved to typography.punctuation.hyperbole
  • consistency.spelling has been moved to spelling.consistency
  • consistency has been removed
  • All modules that previously contained a single check file have been flattened
    • archaism.misc is now archaism
    • hedging.misc is now hedging
    • lexical_illusions.misc is now lexical_illusions
    • malapropisms.misc is now malapropisms
    • mixed_metaphors.misc.bottleneck is now mixed_metaphors.bottleneck
    • misc.mondegreens is now mondegreens
    • needless_variants.misc is now needless_variants
    • nonwords.misc is now nonwords
    • oxymorons.misc is now oxymorons
    • skunked_terms.misc is now skunked_terms
    • uncomparables.misc is now uncomparables
• There is a new JSON output schema for --output-format json. This is documented, stable, and versioned. Plugins will require updates.
• The on-disk cache has been removed

As a library

• The cache has been removed, along with all related features in proselint.tools
• The score module has been removed
• The build backend is now uv_build
• The topics and context features of proselint.tools have been removed
• The _check functions of proselint.tools have been replaced by classes in proselint.registry.checks.types
• Checks are now specified with Check in proselint.registry.checks
• Lint runs are executed with LintFile and return LintResult, both in proselint.tools
• The ppm_threshold wrapper in proselint.tools has been replaced by CheckFlags in proselint.registry.checks
• The max_errors wrapper in proselint.tools has been removed
• load_options in proselint.tools has been replaced by the proselint.config module
• errors_to_json in proselint.tools has been replaced by LintResult.into_dict

⛰️ Features

• (registry) Add strict padding for checks (#​1428) - (f1894bc)
• Override keys and dot-prop (#​1440) - (ddebe9f)
• Add flag to prevent filtering quotes in lintfile (#​1404) - (109f58f)
• Implement check registry (#​1396) - (3bc0d13)

🐛 Bug Fixes

• (checks) Ignore least and most in uncomparables after at (#​1433) - (b94542c)
• (checks) Allow very well in weasel_words (#​1426) - (616e855)
• (checks) Resolve meantime/meanwhile conflict in misc.preferred_forms (#​1425) - (18ecce6)
• (registry) [breaking] Remove results_limit (#​1421) - (d77cd1b)
• Move chocolatey to spelling.consistency (#​1432) - (7a2d503)
• Simplify but check and properly count lines (#​1423) - (68be196)
• Rectify capitalisation in preferred forms (#​1413) - (81d2ea1)
• Check venery-waxed return types (#​1414) - (b481488)
• Update Sublime plugin for SublimeLinter4 (#​1107) - (8df0966)

🚜 Refactor

• (cli) Switch click -> argparse and add logging (#​1400) - (01b507e)
• (config) Remove unused copy import (#​1402) - (cd19388)
• (tools) Upgrade internals (#​1399) - (d9db2c5)
• Stabilise wire logging (#​1444) - (02e85a8)
• [breaking] Upgrade to python 3.10 (#​1435) - (1b986fe)
• [breaking] Remove unused corpus scoring (#​1403) - (85fde74)
• Implement iterators for check results (#​1398) - (fa73970)
• Modernise config (#​1394) - (0e1feba)
• Tidy checks (#​1383) - (053295c)

📚 Documentation

• Update treewide documentation (#​1445) - (7296f20)

⚡ Performance

• (checks) [breaking] Use dual engine system (#​1436) - (e12a943)
• (cli) Import version lazily (#​1438) - (7bfb8f1)
• (registry) Early exit matches_partial (#​1441) - (9fa6339)
• (tools) Use bisect for boundary checks (#​1407) - (c80ef08)

⚙️ Miscellaneous Tasks

• (gh) Remove pr frontmatter - (da58e87)
• (publish) Bypass protections (#​1447) - (200a817)
• (publish) Fix release configurations (#​1446) - (79885f8)
• Prepare release v0.16.0 - (a83a616)
• Prepare release v0.15.0 - (19827df)
• Use nix for workflows (#​1416) - (9c24e8c)
• Update issue templates (#​1420) - (35e7686)
• Update workflows (#​1419) - (7280204)
• Ignore .envrc and .direnv (#​1415) - (6bf7ab5)
• Remove danger (#​1384) - (def7995)
• Update ci and flake (#​1386) - (35e48a0)
• Update tooling (#​1381) - (9132ee4)
• Remove duplicate items from lists (#​1369) - (f01742d)
• Pin runner image versions (#​1368) - (03a7360)

Build

• Fix distribution (#​1417) - (481a2a6)